home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1992 June: ROMin Holiday / ADC Developer CD (1992-06) (''ROMin Holiday'')_iso / Developer Connection - 06-1992.iso / Development Platforms / Apple II / Essentials / APW.ORCA.Cmds / Gregs.APW.Utils / Documentation / Pause < prev    next >
Encoding:
Text File  |  1990-07-19  |  1.6 KB  |  46 lines  |  [TEXT/pdos]
  1. Pause -- wait for keypress
  2.  
  3. Syntax      Pause [prompt]
  4.  
  5. Description Pause displays a prompt on the screen and then waits for a
  6.             keypress.  If the 'prompt' argument is not supplied on the command
  7.             line, the utility will use a default string as the prompt.
  8.  
  9.             After displaying the prompt, the program loops until a key is
  10.             pressed.  If the keypress is a Command-., a status code of -1 is
  11.             returned.  Any other keypress returns a status code of 0.
  12.  
  13.             This utility is most useful for inserting a pause into shell
  14.             command files (EXEC files) which require some action by the user
  15.             prior to continuation of the script.
  16.  
  17. Input       None
  18.  
  19. Output      Pause writes the prompt string to diagnostic output.  This is to
  20.             ensure that the prompt string appears on the console device if
  21.             standard output has been redirected.
  22.  
  23. Diagnostics None
  24.  
  25. Status      The following status codes may be returned:
  26.  
  27.             0   Any key besides Command-. has been pressed.
  28.  
  29.             -1  Command-. has been pressed, signifying that the user wishes to
  30.                 abort the script.
  31.  
  32. Options     A prompt string may be defined on the command line.  This prompt
  33.             string will be displayed instead of the default prompt string.
  34.  
  35. Example:    The following lines appear in a backup script:
  36.  
  37.             .
  38.             .
  39.             .
  40.             Copy -c /Hard.Drive/APW/Source/= /Source.Backup
  41.             Pause Please insert the /Object.Backup disk...
  42.             Copy -c /Hard.Drive/APW/Objects/= /Object.Backup
  43.             .
  44.             .
  45.             .
  46.